Repository navigation
Match whole words when bolding member names in MDN comments - #2576
Open
Ngo Quoc Viet (NgoQuocViet2001) wants to merge 1 commit into
Open
Ngo Quoc Viet (NgoQuocViet2001) wants to merge 1 commit into
Ngo Quoc Viet (NgoQuocViet2001) wants to merge 1 commit into
Conversation
Contributor
|
Thanks for the PR! This section of the codebase is owned by Kagami Sascha Rosylight (@saschanaz) - if they write a comment saying "LGTM" then it will be merged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The MDN comment generator bolds the first regex match of the member name, but the pattern has no word boundaries, so short names get matched inside other words. The current baselines ship comments like:
The same thing happens for HTMLImageElement.y and SVGMaskElement.y ("read-onl**
y** y property"), for Window.top and the globaltop("**topmost window") and for TextEvent.initTextEvent ("initTextEvent**Event()").This adds
\baround the name in the regex, in line with the space-delimited matching suggested in the #2171 review.Interface.nameandname()matches still work. "topmost" and MDN's "initTextEventEvent()" typo have no standalone match, so those two summaries are now left unbolded. Only these comment lines change in the dom and worker baselines.Ran:
npm run generate, thennpm test: passnpx tsgo: passChecked:
node ./src/test.tsfails on the DOMPointReadOnly.y comment in dom.generated.d.ts.